<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="creator library API docs, for the Dart programming language.">
  <title>creator library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">yuuna</a></li>
    <li class="self-crumb">creator library</li>
  </ol>
  <div class="self-name">creator</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
    
      <div>
<h1><span class="kind-library">creator</span> library 
 
</h1></div>

    


    <section class="summary offset-anchor" id="classes">
      <h2>Classes</h2>

      <dl>
        <dt id="AddToStashAction">
  <span class="name "><a href="../creator/AddToStashAction-class.html">AddToStashAction</a></span> 

</dt>
<dd>
  An enhancement used as a shortcut for adding text items to the Stash.
</dd>

        <dt id="AnkiMapping">
  <span class="name "><a href="../creator/AnkiMapping-class.html">AnkiMapping</a></span> 

</dt>
<dd>
  A user-generated mapping to allow customisation of the fields exported from
the application. A mapping is bound to a <a href="../creator/AnkiMapping/model.html">model</a>, which must have a length
of fields equal or more than the length of <a href="../creator/AnkiMapping/getExportFields.html">getExportFields</a>.
</dd>

        <dt id="AudioEnhancement">
  <span class="name "><a href="../creator/AudioEnhancement-class.html">AudioEnhancement</a></span> 

</dt>
<dd>
  An entity for enhancements that specificallly generate audio.
</dd>

        <dt id="AudioExportField">
  <span class="name "><a href="../creator/AudioExportField-class.html">AudioExportField</a></span> 

</dt>
<dd>
  A special kind of field that has a special widget at the top of the creator.
For example, the audio field has a media player that can be controlled
based on its values.
</dd>

        <dt id="AudioField">
  <span class="name "><a href="../creator/AudioField-class.html">AudioField</a></span> 

</dt>
<dd>
  Returns audio information from context.
</dd>

        <dt id="AudioRecorderEnhancement">
  <span class="name "><a href="../creator/AudioRecorderEnhancement-class.html">AudioRecorderEnhancement</a></span> 

</dt>
<dd>
  An enhancement that can be used to record audio.
</dd>

        <dt id="AudioSentenceField">
  <span class="name "><a href="../creator/AudioSentenceField-class.html">AudioSentenceField</a></span> 

</dt>
<dd>
  Returns audio information from context.
</dd>

        <dt id="BingImagesSearchEnhancement">
  <span class="name "><a href="../creator/BingImagesSearchEnhancement-class.html">BingImagesSearchEnhancement</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for clearing the contents
of a <a href="../models/CreatorModel-class.html">CreatorModel</a> pertaining to a certain field.
</dd>

        <dt id="CameraEnhancement">
  <span class="name "><a href="../creator/CameraEnhancement-class.html">CameraEnhancement</a></span> 

</dt>
<dd>
  An enhancement that can be used to take a picture to set a new image.
</dd>

        <dt id="CardCreatorAction">
  <span class="name "><a href="../creator/CardCreatorAction-class.html">CardCreatorAction</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for opening the Card Creator.
</dd>

        <dt id="ClearFieldEnhancement">
  <span class="name "><a href="../creator/ClearFieldEnhancement-class.html">ClearFieldEnhancement</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for clearing the contents
of a <a href="../models/CreatorModel-class.html">CreatorModel</a> pertaining to a certain field.
</dd>

        <dt id="ClozeAfterField">
  <span class="name "><a href="../creator/ClozeAfterField-class.html">ClozeAfterField</a></span> 

</dt>
<dd>
  Text after highlighted text in a sentence.
</dd>

        <dt id="ClozeBeforeField">
  <span class="name "><a href="../creator/ClozeBeforeField-class.html">ClozeBeforeField</a></span> 

</dt>
<dd>
  Text before highlighted text in a sentence
</dd>

        <dt id="ClozeInsideField">
  <span class="name "><a href="../creator/ClozeInsideField-class.html">ClozeInsideField</a></span> 

</dt>
<dd>
  Highlighted text in a sentence.
</dd>

        <dt id="CollapsedMeaningField">
  <span class="name "><a href="../creator/CollapsedMeaningField-class.html">CollapsedMeaningField</a></span> 

</dt>
<dd>
  Used to return a formatted text from hidden dictionary entries from
collapsed dictionaries only.
</dd>

        <dt id="ContextField">
  <span class="name "><a href="../creator/ContextField-class.html">ContextField</a></span> 

</dt>
<dd>
  Returns information about the current context in human-readable format
</dd>

        <dt id="CopyToClipboardAction">
  <span class="name "><a href="../creator/CopyToClipboardAction-class.html">CopyToClipboardAction</a></span> 

</dt>
<dd>
  An enhancement that is useful for copying the headword term.
</dd>

        <dt id="CreatorFieldValues">
  <span class="name "><a href="../creator/CreatorFieldValues-class.html">CreatorFieldValues</a></span> 

</dt>
<dd>
  A collection of values that can be used to mutate the current context of
the creator.
</dd>

        <dt id="CropImageEnhancement">
  <span class="name "><a href="../creator/CropImageEnhancement-class.html">CropImageEnhancement</a></span> 

</dt>
<dd>
  An enhancement that can be used to crop the current image.
</dd>

        <dt id="Enhancement">
  <span class="name "><a href="../creator/Enhancement-class.html">Enhancement</a></span> 

</dt>
<dd>
  An entity that functionally mutates creator fields and returns an output.
An enhancement is given and assigned a field at runtime in the
initialisation step, and can be assigned to a field enhancement slot.
In the creator, the user can then tap on the icon representing the
enhancement to execute its functionality.
</dd>

        <dt id="ExpandedMeaningField">
  <span class="name "><a href="../creator/ExpandedMeaningField-class.html">ExpandedMeaningField</a></span> 

</dt>
<dd>
  Used to return a formatted text from multiple dictionary entries from
expanded dictionaries only.
</dd>

        <dt id="Field">
  <span class="name "><a href="../creator/Field-class.html">Field</a></span> 

</dt>
<dd>
  An entity that represents a broad characteristic of an item being
exported that is distinguishable enough to deserve its own core
functionality and family of user extensions. For example, a field
could handle exclusively images, or dictionary definitions.
</dd>

        <dt id="ForvoAudioEnhancement">
  <span class="name "><a href="../creator/ForvoAudioEnhancement-class.html">ForvoAudioEnhancement</a></span> 

</dt>
<dd>
  An enhancement for fetching audio from Forvo.
</dd>

        <dt id="ForvoResult">
  <span class="name "><a href="../creator/ForvoResult-class.html">ForvoResult</a></span> 

</dt>
<dd>
  An entity used to neatly return and organise results fetched from Forvo.
</dd>

        <dt id="FrequencyField">
  <span class="name "><a href="../creator/FrequencyField-class.html">FrequencyField</a></span> 

</dt>
<dd>
  Returns the frequency of a <a href="../dictionary/DictionaryHeading-class.html">DictionaryHeading</a> (uses harmonic mean for
multiple entries, idea taken from @MarvNC).
</dd>

        <dt id="FuriganaField">
  <span class="name "><a href="../creator/FuriganaField-class.html">FuriganaField</a></span> 

</dt>
<dd>
  Returns the formatted furigana HTML of a <a href="../dictionary/DictionaryHeading-class.html">DictionaryHeading</a>.
</dd>

        <dt id="HiddenMeaningField">
  <span class="name "><a href="../creator/HiddenMeaningField-class.html">HiddenMeaningField</a></span> 

</dt>
<dd>
  Used to return a formatted text from hidden dictionary entries.
</dd>

        <dt id="ImageEnhancement">
  <span class="name "><a href="../creator/ImageEnhancement-class.html">ImageEnhancement</a></span> 

</dt>
<dd>
  An entity for enhancements that specificallly generate images.
</dd>

        <dt id="ImageExportField">
  <span class="name "><a href="../creator/ImageExportField-class.html">ImageExportField</a></span> 

</dt>
<dd>
  A special kind of field that has a special widget at the top of the creator.
For example, the audio field has a media player that can be controlled
based on its values.
</dd>

        <dt id="ImageField">
  <span class="name "><a href="../creator/ImageField-class.html">ImageField</a></span> 

</dt>
<dd>
  Returns audio information from context.
</dd>

        <dt id="ImmersionKitEnhancement">
  <span class="name "><a href="../creator/ImmersionKitEnhancement-class.html">ImmersionKitEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to fetch example sentences via Massif.
</dd>

        <dt id="ImmersionKitResult">
  <span class="name "><a href="../creator/ImmersionKitResult-class.html">ImmersionKitResult</a></span> 

</dt>
<dd>
  An entity used to neatly return and organise results fetched from
ImmersionKit.
</dd>

        <dt id="InstantExportAction">
  <span class="name "><a href="../creator/InstantExportAction-class.html">InstantExportAction</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for exporting a card.
</dd>

        <dt id="JapanesePod101AudioEnhancement">
  <span class="name "><a href="../creator/JapanesePod101AudioEnhancement-class.html">JapanesePod101AudioEnhancement</a></span> 

</dt>
<dd>
  An enhancement for fetching audio from JapanesePod101.
</dd>

        <dt id="MassifExampleSentencesEnhancement">
  <span class="name "><a href="../creator/MassifExampleSentencesEnhancement-class.html">MassifExampleSentencesEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to fetch example sentences via Massif.
</dd>

        <dt id="MassifResult">
  <span class="name "><a href="../creator/MassifResult-class.html">MassifResult</a></span> 

</dt>
<dd>
  An entity used to neatly return and organise results fetched from Massif.
</dd>

        <dt id="MeaningField">
  <span class="name "><a href="../creator/MeaningField-class.html">MeaningField</a></span> 

</dt>
<dd>
  Used to return a formatted text from multiple dictionary entries.
</dd>

        <dt id="MediaField">
  <span class="name "><a href="../creator/MediaField-class.html">MediaField</a></span> 

</dt>
<dd>
  A special kind of field that has a special widget at the top of the creator.
For example, the audio field has a media player that can be controlled
based on its values.
</dd>

        <dt id="NotesField">
  <span class="name "><a href="../creator/NotesField-class.html">NotesField</a></span> 

</dt>
<dd>
  Supplies supplementary data that may be useful to include in a card.
</dd>

        <dt id="OpenStashEnhancement">
  <span class="name "><a href="../creator/OpenStashEnhancement-class.html">OpenStashEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to view and manage the Stash.
</dd>

        <dt id="PickAudioEnhancement">
  <span class="name "><a href="../creator/PickAudioEnhancement-class.html">PickAudioEnhancement</a></span> 

</dt>
<dd>
  An enhancement that can be used to select an audio file.
</dd>

        <dt id="PickImageEnhancement">
  <span class="name "><a href="../creator/PickImageEnhancement-class.html">PickImageEnhancement</a></span> 

</dt>
<dd>
  An enhancement that can be used to select a picture with the
</dd>

        <dt id="PitchAccentField">
  <span class="name "><a href="../creator/PitchAccentField-class.html">PitchAccentField</a></span> 

</dt>
<dd>
  Returns the formatted pitch accent diagram HTML of a <a href="../dictionary/DictionaryHeading-class.html">DictionaryHeading</a>.
</dd>

        <dt id="PitchSvg">
  <span class="name "><a href="../creator/PitchSvg-class.html">PitchSvg</a></span> 

</dt>
<dd>
  Pitch utilities courtesy of Matthew Chan.
https://github.com/mathewthe2/immersion_reader/blob/main/lib/japanese/pitch.dart
</dd>

        <dt id="PlayAudioAction">
  <span class="name "><a href="../creator/PlayAudioAction-class.html">PlayAudioAction</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for previewing audio.
</dd>

        <dt id="PopFromStashEnhancement">
  <span class="name "><a href="../creator/PopFromStashEnhancement-class.html">PopFromStashEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to pop the latest element of the Stash onto a field.
</dd>

        <dt id="QuickAction">
  <span class="name "><a href="../creator/QuickAction-class.html">QuickAction</a></span> 

</dt>
<dd>
  An entity that executes an action when selected on the upper-right of a
dictionary entry widget. An action is initialised at runtime in the
initialisation step, and can be assigned to a quick action slot.
When dictionary search results are displayed, the user can then tap on the
icon representing the action to execute its functionality for a certain
dictionary entry.
</dd>

        <dt id="ReadingField">
  <span class="name "><a href="../creator/ReadingField-class.html">ReadingField</a></span> 

</dt>
<dd>
  Used to track the current sentence context from the current playing media
in the application.
</dd>

        <dt id="SaveTagsEnhancement">
  <span class="name "><a href="../creator/SaveTagsEnhancement-class.html">SaveTagsEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to save the Tags field's last value.
</dd>

        <dt id="SearchDictionaryEnhancement">
  <span class="name "><a href="../creator/SearchDictionaryEnhancement-class.html">SearchDictionaryEnhancement</a></span> 

</dt>
<dd>
  An enhancement used effectively as a shortcut for performing a dictionary
search.
</dd>

        <dt id="SearchHistoryItem">
  <span class="name "><a href="../creator/SearchHistoryItem-class.html">SearchHistoryItem</a></span> 

</dt>
<dd>
  A collection of search history items given a certain name.
</dd>

        <dt id="SentenceField">
  <span class="name "><a href="../creator/SentenceField-class.html">SentenceField</a></span> 

</dt>
<dd>
  Used to track the current sentence context from the current playing media
in the application.
</dd>

        <dt id="SentencePickerEnhancement">
  <span class="name "><a href="../creator/SentencePickerEnhancement-class.html">SentencePickerEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to pick a sentence from text.
</dd>

        <dt id="ShareAction">
  <span class="name "><a href="../creator/ShareAction-class.html">ShareAction</a></span> 

</dt>
<dd>
  An enhancement that calls the native share API for sharing word details.
</dd>

        <dt id="TagsField">
  <span class="name "><a href="../creator/TagsField-class.html">TagsField</a></span> 

</dt>
<dd>
  Organise notes in a deck with space-delimited labels.
</dd>

        <dt id="TatoebaExampleSentencesEnhancement">
  <span class="name "><a href="../creator/TatoebaExampleSentencesEnhancement-class.html">TatoebaExampleSentencesEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to fetch example sentences via Tatoeba.
</dd>

        <dt id="TermField">
  <span class="name "><a href="../creator/TermField-class.html">TermField</a></span> 

</dt>
<dd>
  Returns the word or phrase particular to a selected headword.
</dd>

        <dt id="TextSegmentationEnhancement">
  <span class="name "><a href="../creator/TextSegmentationEnhancement-class.html">TextSegmentationEnhancement</a></span> 

</dt>
<dd>
  An enhancement used to pick an appropriate term from a text field easily.
</dd>

      </dl>
    </section>

    <section class="summary offset-anchor" id="mixins">
      <h2>Mixins</h2>

      <dl>
        <dt id="AudioGeneratorMixin">
  <span class="name "><a href="../creator/AudioGeneratorMixin-mixin.html">AudioGeneratorMixin</a></span> 

</dt>
<dd>
  Used for entities that can generate a single audio file from a <a href="../media/MediaItem-class.html">MediaItem</a>
seed.
</dd>

        <dt id="ImageGeneratorMixin">
  <span class="name "><a href="../creator/ImageGeneratorMixin-mixin.html">ImageGeneratorMixin</a></span> 

</dt>
<dd>
  Used for entities that can generate a single image from a <a href="../media/MediaItem-class.html">MediaItem</a> seed.
</dd>

      </dl>
    </section>

    <section class="summary offset-anchor" id="extensions">
      <h2>Extensions</h2>

      <dl>
        <dt id="AnkiMappingByIndex">
    <span class="name "><a href="../creator/AnkiMappingByIndex.html">AnkiMappingByIndex</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryFilter">
    <span class="name "><a href="../creator/AnkiMappingQueryFilter.html">AnkiMappingQueryFilter</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryLinks">
    <span class="name "><a href="../creator/AnkiMappingQueryLinks.html">AnkiMappingQueryLinks</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryObject">
    <span class="name "><a href="../creator/AnkiMappingQueryObject.html">AnkiMappingQueryObject</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryProperty">
    <span class="name "><a href="../creator/AnkiMappingQueryProperty.html">AnkiMappingQueryProperty</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQuerySortBy">
    <span class="name "><a href="../creator/AnkiMappingQuerySortBy.html">AnkiMappingQuerySortBy</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQuerySortThenBy">
    <span class="name "><a href="../creator/AnkiMappingQuerySortThenBy.html">AnkiMappingQuerySortThenBy</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryWhere">
    <span class="name "><a href="../creator/AnkiMappingQueryWhere.html">AnkiMappingQueryWhere</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryWhereDistinct">
    <span class="name "><a href="../creator/AnkiMappingQueryWhereDistinct.html">AnkiMappingQueryWhereDistinct</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="AnkiMappingQueryWhereSort">
    <span class="name "><a href="../creator/AnkiMappingQueryWhereSort.html">AnkiMappingQueryWhereSort</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="GetAnkiMappingCollection">
    <span class="name "><a href="../creator/GetAnkiMappingCollection.html">GetAnkiMappingCollection</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="GetSearchHistoryItemCollection">
    <span class="name "><a href="../creator/GetSearchHistoryItemCollection.html">GetSearchHistoryItemCollection</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemByIndex">
    <span class="name "><a href="../creator/SearchHistoryItemByIndex.html">SearchHistoryItemByIndex</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryFilter">
    <span class="name "><a href="../creator/SearchHistoryItemQueryFilter.html">SearchHistoryItemQueryFilter</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryLinks">
    <span class="name "><a href="../creator/SearchHistoryItemQueryLinks.html">SearchHistoryItemQueryLinks</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryObject">
    <span class="name "><a href="../creator/SearchHistoryItemQueryObject.html">SearchHistoryItemQueryObject</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryProperty">
    <span class="name "><a href="../creator/SearchHistoryItemQueryProperty.html">SearchHistoryItemQueryProperty</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQuerySortBy">
    <span class="name "><a href="../creator/SearchHistoryItemQuerySortBy.html">SearchHistoryItemQuerySortBy</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQuerySortThenBy">
    <span class="name "><a href="../creator/SearchHistoryItemQuerySortThenBy.html">SearchHistoryItemQuerySortThenBy</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryWhere">
    <span class="name "><a href="../creator/SearchHistoryItemQueryWhere.html">SearchHistoryItemQueryWhere</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryWhereDistinct">
    <span class="name "><a href="../creator/SearchHistoryItemQueryWhereDistinct.html">SearchHistoryItemQueryWhereDistinct</a></span> 

</dt>
<dd>
    
</dd>


        <dt id="SearchHistoryItemQueryWhereSort">
    <span class="name "><a href="../creator/SearchHistoryItemQueryWhereSort.html">SearchHistoryItemQueryWhereSort</a></span> 

</dt>
<dd>
    
</dd>


      </dl>
    </section>

    <section class="summary offset-anchor" id="constants">
      <h2>Constants</h2>

      <dl class="properties">
        <dt id="AnkiMappingSchema" class="constant">
    <span class="name "><a href="../creator/AnkiMappingSchema-constant.html">AnkiMappingSchema</a></span>
  <span class="signature">&#8594; const <a href="https://pub.dev/documentation/isar/3.1.0+1/isar/CollectionSchema-class.html">CollectionSchema</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../creator/AnkiMapping-class.html">AnkiMapping</a></span>&gt;</span></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>CollectionSchema(name: r&#39;AnkiMapping&#39;, id: -9131188405906642167, properties: {r&#39;actionsIsar&#39; : PropertySchema(id: 0, name: r&#39;actionsIsar&#39;, type: IsarType.string), r&#39;creator…</code></span>
    </div>
</dd>

        <dt id="SearchHistoryItemSchema" class="constant">
    <span class="name "><a href="../creator/SearchHistoryItemSchema-constant.html">SearchHistoryItemSchema</a></span>
  <span class="signature">&#8594; const <a href="https://pub.dev/documentation/isar/3.1.0+1/isar/CollectionSchema-class.html">CollectionSchema</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../creator/SearchHistoryItem-class.html">SearchHistoryItem</a></span>&gt;</span></span>
  

</dt>
<dd>
  
  

    <div>
      <span class="signature"><code>CollectionSchema(name: r&#39;SearchHistoryItem&#39;, id: 7309085037371405047, properties: {r&#39;historyKey&#39; : PropertySchema(id: 0, name: r&#39;historyKey&#39;, type: IsarType.string), r&#39;sear…</code></span>
    </div>
</dd>

      </dl>
    </section>



    <section class="summary offset-anchor" id="enums">
      <h2>Enums</h2>

      <dl>
        <dt id="EnhancementTriggerCause">
  <span class="name "><a href="../creator/EnhancementTriggerCause.html">EnhancementTriggerCause</a></span> 

</dt>
<dd>
  List of causes that may be of interest when executing an enhancement and
may change the context of how the enhancement should be executed.
</dd>

        <dt id="SortingMethod">
  <span class="name "><a href="../creator/SortingMethod.html">SortingMethod</a></span> 

</dt>
<dd>
  The method by which the frequency value is calculated.
</dd>

      </dl>
    </section>



  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">yuuna</a></li>
  <li class="self-crumb">creator library</li>
</ol>


    <h5><span class="package-name">yuuna</span> <span class="package-kind">package</span></h5>
    <ol>
      <li class="section-title">Libraries</li>
      <li><a href="../creator/creator-library.html">creator</a></li>
      <li><a href="../dictionary/dictionary-library.html">dictionary</a></li>
      <li><a href="../language/language-library.html">language</a></li>
      <li><a href="../main/main-library.html">main</a></li>
      <li><a href="../media/media-library.html">media</a></li>
      <li><a href="../models/models-library.html">models</a></li>
      <li><a href="../pages/pages-library.html">pages</a></li>
      <li><a href="../i18n_strings.g/i18n_strings.g-library.html">strings.g</a></li>
      <li><a href="../utils/utils-library.html">utils</a></li>
</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <h5>creator library</h5>
    <ol>
      <li class="section-title"><a href="../creator/creator-library.html#classes">Classes</a></li>
        <li><a href="../creator/AddToStashAction-class.html">AddToStashAction</a></li>
        <li><a href="../creator/AnkiMapping-class.html">AnkiMapping</a></li>
        <li><a href="../creator/AudioEnhancement-class.html">AudioEnhancement</a></li>
        <li><a href="../creator/AudioExportField-class.html">AudioExportField</a></li>
        <li><a href="../creator/AudioField-class.html">AudioField</a></li>
        <li><a href="../creator/AudioRecorderEnhancement-class.html">AudioRecorderEnhancement</a></li>
        <li><a href="../creator/AudioSentenceField-class.html">AudioSentenceField</a></li>
        <li><a href="../creator/BingImagesSearchEnhancement-class.html">BingImagesSearchEnhancement</a></li>
        <li><a href="../creator/CameraEnhancement-class.html">CameraEnhancement</a></li>
        <li><a href="../creator/CardCreatorAction-class.html">CardCreatorAction</a></li>
        <li><a href="../creator/ClearFieldEnhancement-class.html">ClearFieldEnhancement</a></li>
        <li><a href="../creator/ClozeAfterField-class.html">ClozeAfterField</a></li>
        <li><a href="../creator/ClozeBeforeField-class.html">ClozeBeforeField</a></li>
        <li><a href="../creator/ClozeInsideField-class.html">ClozeInsideField</a></li>
        <li><a href="../creator/CollapsedMeaningField-class.html">CollapsedMeaningField</a></li>
        <li><a href="../creator/ContextField-class.html">ContextField</a></li>
        <li><a href="../creator/CopyToClipboardAction-class.html">CopyToClipboardAction</a></li>
        <li><a href="../creator/CreatorFieldValues-class.html">CreatorFieldValues</a></li>
        <li><a href="../creator/CropImageEnhancement-class.html">CropImageEnhancement</a></li>
        <li><a href="../creator/Enhancement-class.html">Enhancement</a></li>
        <li><a href="../creator/ExpandedMeaningField-class.html">ExpandedMeaningField</a></li>
        <li><a href="../creator/Field-class.html">Field</a></li>
        <li><a href="../creator/ForvoAudioEnhancement-class.html">ForvoAudioEnhancement</a></li>
        <li><a href="../creator/ForvoResult-class.html">ForvoResult</a></li>
        <li><a href="../creator/FrequencyField-class.html">FrequencyField</a></li>
        <li><a href="../creator/FuriganaField-class.html">FuriganaField</a></li>
        <li><a href="../creator/HiddenMeaningField-class.html">HiddenMeaningField</a></li>
        <li><a href="../creator/ImageEnhancement-class.html">ImageEnhancement</a></li>
        <li><a href="../creator/ImageExportField-class.html">ImageExportField</a></li>
        <li><a href="../creator/ImageField-class.html">ImageField</a></li>
        <li><a href="../creator/ImmersionKitEnhancement-class.html">ImmersionKitEnhancement</a></li>
        <li><a href="../creator/ImmersionKitResult-class.html">ImmersionKitResult</a></li>
        <li><a href="../creator/InstantExportAction-class.html">InstantExportAction</a></li>
        <li><a href="../creator/JapanesePod101AudioEnhancement-class.html">JapanesePod101AudioEnhancement</a></li>
        <li><a href="../creator/MassifExampleSentencesEnhancement-class.html">MassifExampleSentencesEnhancement</a></li>
        <li><a href="../creator/MassifResult-class.html">MassifResult</a></li>
        <li><a href="../creator/MeaningField-class.html">MeaningField</a></li>
        <li><a href="../creator/MediaField-class.html">MediaField</a></li>
        <li><a href="../creator/NotesField-class.html">NotesField</a></li>
        <li><a href="../creator/OpenStashEnhancement-class.html">OpenStashEnhancement</a></li>
        <li><a href="../creator/PickAudioEnhancement-class.html">PickAudioEnhancement</a></li>
        <li><a href="../creator/PickImageEnhancement-class.html">PickImageEnhancement</a></li>
        <li><a href="../creator/PitchAccentField-class.html">PitchAccentField</a></li>
        <li><a href="../creator/PitchSvg-class.html">PitchSvg</a></li>
        <li><a href="../creator/PlayAudioAction-class.html">PlayAudioAction</a></li>
        <li><a href="../creator/PopFromStashEnhancement-class.html">PopFromStashEnhancement</a></li>
        <li><a href="../creator/QuickAction-class.html">QuickAction</a></li>
        <li><a href="../creator/ReadingField-class.html">ReadingField</a></li>
        <li><a href="../creator/SaveTagsEnhancement-class.html">SaveTagsEnhancement</a></li>
        <li><a href="../creator/SearchDictionaryEnhancement-class.html">SearchDictionaryEnhancement</a></li>
        <li><a href="../creator/SearchHistoryItem-class.html">SearchHistoryItem</a></li>
        <li><a href="../creator/SentenceField-class.html">SentenceField</a></li>
        <li><a href="../creator/SentencePickerEnhancement-class.html">SentencePickerEnhancement</a></li>
        <li><a href="../creator/ShareAction-class.html">ShareAction</a></li>
        <li><a href="../creator/TagsField-class.html">TagsField</a></li>
        <li><a href="../creator/TatoebaExampleSentencesEnhancement-class.html">TatoebaExampleSentencesEnhancement</a></li>
        <li><a href="../creator/TermField-class.html">TermField</a></li>
        <li><a href="../creator/TextSegmentationEnhancement-class.html">TextSegmentationEnhancement</a></li>

      <li class="section-title"><a href="../creator/creator-library.html#extensions">Extensions</a></li>
        <li><a href="../creator/AnkiMappingByIndex.html">AnkiMappingByIndex</a></li>
        <li><a href="../creator/AnkiMappingQueryFilter.html">AnkiMappingQueryFilter</a></li>
        <li><a href="../creator/AnkiMappingQueryLinks.html">AnkiMappingQueryLinks</a></li>
        <li><a href="../creator/AnkiMappingQueryObject.html">AnkiMappingQueryObject</a></li>
        <li><a href="../creator/AnkiMappingQueryProperty.html">AnkiMappingQueryProperty</a></li>
        <li><a href="../creator/AnkiMappingQuerySortBy.html">AnkiMappingQuerySortBy</a></li>
        <li><a href="../creator/AnkiMappingQuerySortThenBy.html">AnkiMappingQuerySortThenBy</a></li>
        <li><a href="../creator/AnkiMappingQueryWhere.html">AnkiMappingQueryWhere</a></li>
        <li><a href="../creator/AnkiMappingQueryWhereDistinct.html">AnkiMappingQueryWhereDistinct</a></li>
        <li><a href="../creator/AnkiMappingQueryWhereSort.html">AnkiMappingQueryWhereSort</a></li>
        <li><a href="../creator/GetAnkiMappingCollection.html">GetAnkiMappingCollection</a></li>
        <li><a href="../creator/GetSearchHistoryItemCollection.html">GetSearchHistoryItemCollection</a></li>
        <li><a href="../creator/SearchHistoryItemByIndex.html">SearchHistoryItemByIndex</a></li>
        <li><a href="../creator/SearchHistoryItemQueryFilter.html">SearchHistoryItemQueryFilter</a></li>
        <li><a href="../creator/SearchHistoryItemQueryLinks.html">SearchHistoryItemQueryLinks</a></li>
        <li><a href="../creator/SearchHistoryItemQueryObject.html">SearchHistoryItemQueryObject</a></li>
        <li><a href="../creator/SearchHistoryItemQueryProperty.html">SearchHistoryItemQueryProperty</a></li>
        <li><a href="../creator/SearchHistoryItemQuerySortBy.html">SearchHistoryItemQuerySortBy</a></li>
        <li><a href="../creator/SearchHistoryItemQuerySortThenBy.html">SearchHistoryItemQuerySortThenBy</a></li>
        <li><a href="../creator/SearchHistoryItemQueryWhere.html">SearchHistoryItemQueryWhere</a></li>
        <li><a href="../creator/SearchHistoryItemQueryWhereDistinct.html">SearchHistoryItemQueryWhereDistinct</a></li>
        <li><a href="../creator/SearchHistoryItemQueryWhereSort.html">SearchHistoryItemQueryWhereSort</a></li>

      <li class="section-title"><a href="../creator/creator-library.html#mixins">Mixins</a></li>
        <li><a href="../creator/AudioGeneratorMixin-mixin.html">AudioGeneratorMixin</a></li>
        <li><a href="../creator/ImageGeneratorMixin-mixin.html">ImageGeneratorMixin</a></li>

      <li class="section-title"><a href="../creator/creator-library.html#constants">Constants</a></li>
        <li><a href="../creator/AnkiMappingSchema-constant.html">AnkiMappingSchema</a></li>
        <li><a href="../creator/SearchHistoryItemSchema-constant.html">SearchHistoryItemSchema</a></li>



      <li class="section-title"><a href="../creator/creator-library.html#enums">Enums</a></li>
        <li><a href="../creator/EnhancementTriggerCause.html">EnhancementTriggerCause</a></li>
        <li><a href="../creator/SortingMethod.html">SortingMethod</a></li>


</ol>

  </div><!--/sidebar-offcanvas-right-->

</main>

<footer>
  <span class="no-break">
    yuuna
      2.8.0+93
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

